Itential Tools

This guide provides detailed information about what to input for the params of itential_tools actions.

itential_tools Actions

The actions provided by itential_tools are listed below.

Method	Description
admin_down_device	Admin down, all admin up interfaces.
admin_down_interfaces	Admin down interfaces.
admin_up_interfaces	Admin up interfaces.
getNamespaces	Get namespace URI for the prefix given.
get_config	Get config.
load_config	Load config XML.
native2Pronghorn	Use NED to convert native config into XPath.
set_config	Set config.
set_config_transactions	Set config.
stage_device	Stage device from config.
translate_config	Translate config from native to set.
verify_config	Verify NED can read config.

How to test

All actions can be tested by utilizing the runAction task in Adapter NSO of workflows.

1. Go to Workflows in Automation Studio.
2. Create a new workflow and add the runAction task from NSO/NSOManager to the workflow canvas.
3. Input the parameters according to the action running.

Examples

Several examples of the actions in itential_tools are shown below. Sample input values are used to illustrate the reference variable you would enter for each Incoming Variable on the task dialog.

admin_down_device

Variable: params

{
    "params": {
        "device": "ios.1"
    },
    "path": "/itential_commands/admin_down_device"
}

admin_down_interfaces

Variable: params

{
    "params": {
        "device": "ios.0",
        "interfaces": "[\"GigabitEthernet{0}\",\"\"Ethernet{0/0/0}\"]"
    },
    "path": "/itential_commands/admin_down_interfaces"
}

admin_up_interfaces

Variable: params

{
    "params": {
        "device": "ios.0",
        "interfaces": "[\"GigabitEthernet{0}\"]"
    },
    "path": "/itential_commands/admin_up_interfaces"
}

getNamespaces

Variable: params

{
    "params": {
        "deviceName": "ios.0",
        "prefixes": "ncs"
    },
    "path": "/itential_commands/getNamespaces"
}

get_config

Variable: params

{
    "params": {
        "device": "ios.0",
        "format": "NATIVE"
    },
    "path": "/itential_commands/get_config"
}

load_config

Variable: params

{
    "params": {
        "device": "ios.0",
        "action": "MERGE",
        "config": "<config xmlns=\"http://tail-f.com/ns/config/1.0\"><devices xmlns=\"http://tail-f.com/ns/ncs\"><device><name>ios.0</name><config><tailfned xmlns=\"urn:ios\"><police>cirmode</police></tailfned><ip xmlns=\"urn:ios\"><source-route>true</source-route><gratuitous-arps-conf><gratuitous-arps>true</gratuitous-arps></gratuitous-arps-conf><http><server>true</server><secure-server>true</secure-server></http></ip></config></device></devices></config>"
    },
    "path": "/itential_commands/load_config"
}

native2Pronghorn

Variable: params

{
    "params": {
        "ned_id": "cisco-ios-cli-6.72",
        "commands": "hostname test"
    },
    "path": "/itential_commands/native2Pronghorn"
}

set_config

Variable: params

{
    "params": {
        "device": "ios.0",
        "config": "hostname test",
        "deviceType": "cisco-ios-cli-6.72",
        "dryRun": "cli"
    },
    "path": "/itential_commands/set_config"
}

set_config_transactions

Variable: params

{   "params": {
        "device": "ios.0",
        "deviceType": "cisco-ios-cli-6.72",
        "transactions": {
            "id": 1,
            "new": "hostname test",
            "old": "",
            "parents": ""
        }
    },
    "path": "/itential_commands/set_config_transactions"
}

stage_device

Variable: params

{
    "params": {
        "device_name": "ios.1",
        "ned_id": "cisco-ios-cli-6.72",
        "commands": "hostname test"
    },
    "path": "/itential_commands/stage_device"
}

translate_config

Variable: params

{
    "params": {
        "ned_id": "cisco-ios-cli-6.72",
        "commands": "hostname test",
        "strategy": "access_list"
    },
    "path": "/itential_commands/translate_config"
}

verify_config

Variable: params

{
    "params": {
        "ned_id": "cisco-ios-cli-6.72",
        "commands": "hostname test"
    },
    "path": "/itential_commands/verify_config"
}